/*
 * Copyright 2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package blms.repository;

import java.util.List;
import java.util.regex.PatternSyntaxException;

import blms.domain.User;
import blms.exception.UserDoesNotExistException;

/**
 * Abstract definition of a user repository. User instances may be loaded and
 * stored from different sources.
 * 
 * @see Repository
 * 
 * @author João Arthur
 * @author Jonhnny Weslley
 * @author Thiago Emmanuel
 * @version 1.00, 21/04/2008
 * @since 1.0
 */
public interface UserRepository extends Repository<User> {

	/**
	 * Returns <tt>true</tt> if this {@link UserRepository repository}
	 * contains an user with the specified email
	 * 
	 * @param email
	 *            the user email
	 * @return <tt>true</tt> if this {@link UserRepository repository}
	 *         contains an user with the specified email
	 */
	boolean containsEmail(String email);

	/**
	 * Find the {@link User} with the specified {@link User#getEmail() email},
	 * assuming that the user exists
	 * 
	 * @param email
	 *            The email of the user to be found
	 * @return The user with the specified email
	 * @throws UserDoesNotExistException
	 *             if no users has the specified email
	 */
	User findUserByEmail(String email) throws UserDoesNotExistException;

	/**
	 * Returns a {@code List} of the users contained in this
	 * {@link UserRepository repository} whose last name matches the given
	 * regular expression
	 * 
	 * @param lastName
	 *            the regular expression to which the user's last name is to be
	 *            matched
	 * @return a list of the users contained in this
	 *         {@link UserRepository repository} whose last name matches the
	 *         given regular expression
	 * 
	 * @throws UserDoesNotExistException
	 *             if no users has the last name matched the given regular
	 *             expression
	 * @throws PatternSyntaxException
	 *             if the regular expression's syntax is invalid
	 */
	List<String> findUserByLastName(String lastName)
			throws UserDoesNotExistException;

}
